Skip to content

docs: update README features to reflect current implementation#935

Merged
chaliy merged 5 commits intomainfrom
claude/update-readme-features-OitfJ
Apr 1, 2026
Merged

docs: update README features to reflect current implementation#935
chaliy merged 5 commits intomainfrom
claude/update-readme-features-OitfJ

Conversation

@chaliy
Copy link
Copy Markdown
Contributor

@chaliy chaliy commented Apr 1, 2026

Summary

  • Updated main README feature list from 9 to 15 items, adding security-first positioning, RealFs, LLM tool contract, scripted tool orchestration, MCP server, language bindings, multi-tenant isolation
  • Expanded builtin commands table from ~80 to all 150 commands with new categories (Checksums, Data formats, DevOps)
  • Expanded shell features section from 9 to 20 items (extended globs, namerefs, assoc arrays, process substitution, coprocesses, brace expansion, pipefail, etc.)
  • Added expanded Security section with Defense in Depth table covering all 10 security layers
  • Rewrote JS crate README with full API surface: VFS methods, async execute, cancellation/AbortSignal, ScriptedTool, BashError, file mounts, BashOptions
  • Updated Python crate README with execute_or_throw variants, full FileSystem API, Deep Agents integration, ScriptedTool missing methods
  • Added Bun and Deno support mentions across all READMEs
  • Fixed CLI binary name from bashkit-cli to bashkit
  • Added all feature flags to install section (git, python, realfs, scripted_tool)
  • Added MCP server and RealFs mount flags to CLI usage section

Test plan

  • cargo test --features http_client — all 2900+ tests pass
  • just check (fmt + clippy + test) — passes
  • No code changes — docs only, no functional impact

chaliy added 5 commits April 1, 2026 22:35
The README feature list was significantly outdated — the builtin table
showed ~80 commands when 150 are implemented, shell features listed 9
when 20+ exist, and several major capabilities (JS bindings, RealFs,
scripted tool orchestration, MCP server, additional feature flags) were
not mentioned at all.
JS README: added VFS methods, async execute, cancellation/AbortSignal,
ScriptedTool, BashError, file mounts, extended ExecResult fields, and
Bash.create() factory.

Python README: added execute_or_throw variants, FileSystem API reference,
Deep Agents integration, and ScriptedTool missing methods.
Security is the most important differentiator — now leads the features
list and has a detailed Defense in Depth table covering all 10 security
layers (no process spawning, VFS, network allowlist, resource/fs/parser
limits, multi-tenant isolation, panic recovery, path traversal
prevention, unicode security).
@chaliy chaliy merged commit 20aff9a into main Apr 1, 2026
27 checks passed
@chaliy chaliy deleted the claude/update-readme-features-OitfJ branch April 1, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant